Vcenter Vcha PlacementInfo

The Vcenter Vcha PlacementInfo schema contains information to describe the inventory placement of a single node of a VCHA cluster.
The active node's management vCenter server credentials are required to populate all properties except biosUuid.

This schema was added in vSphere API 6.7.1.

JSON Example

{
    "management_vcenter_name": "string",
    "management_vcenter_server_guid": "string",
    "vm_name": "string",
    "datacenter": "string",
    "datacenter_name": "string",
    "host": "string",
    "host_name": "string",
    "cluster": "string",
    "cluster_name": "string",
    "ha_network": "string",
    "ha_network_name": "string",
    "ha_network_type": "string",
    "management_network": "string",
    "management_network_name": "string",
    "management_network_type": "string",
    "storage": {
        "datastore": "string",
        "datastore_name": "string"
    },
    "bios_uuid": "string"
}

string

management_vcenter_name

Required

The hostname of the vCenter server that is managing the VCHA node.

This property was added in vSphere API 6.7.1.

string

management_vcenter_server_guid

Optional

The unique identifier of the vCenter server that is managing the VCHA node.

This property was added in vSphere API 7.0.0.1.

This property is optional because it was added in a newer version than its parent node.

string

vm_name

Required

The virtual machine name of the VCHA node.

This property was added in vSphere API 6.7.1.

string

datacenter

Required

The identifier of the datacenter of the VCHA node.

This property was added in vSphere API 6.7.1.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Datacenter:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Datacenter:VCenter.

string

datacenter_name

Required

The name of the datacenter of the VCHA node.

This property was added in vSphere API 6.7.1.

string

host

Required

The identifier of the host of the VCHA node.

This property was added in vSphere API 6.7.1.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem:VCenter.

string

host_name

Required

The name of the host of the VCHA node.

This property was added in vSphere API 6.7.1.

string

cluster

Optional

The identifier of the cluster of which host is member.

This property was added in vSphere API 6.7.1.

If missing or null, host is a standalone host.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource:VCenter.

string

cluster_name

Optional

The name of the cluster of which host is member.

This property was added in vSphere API 6.7.1.

If missing or null, host is a standalone host.

string

ha_network

Optional

The identifier of the Network object used for the HA network.

This property was added in vSphere API 6.7.1.

If missing or null, the information is currently unavailable or the haNetwork is not configured.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network:VCenter.

string

ha_network_name

Optional

The name of the Network object used for the HA network.

This property was added in vSphere API 6.7.1.

If missing or null, the information is currently unavailable or the haNetwork is not configured.

string

ha_network_type

Optional

The type of the Network object used for the HA network.

For more information see: Vcenter Vcha NetworkType.

This property was added in vSphere API 6.7.1.

If missing or null, the information is currently unavailable or the haNetwork is not configured.

string

management_network

Required

The identifier of the Network object used for the Management network.

This property was added in vSphere API 6.7.1.

string

management_network_name

Required

The name of the Network object used for the Management network.

This property was added in vSphere API 6.7.1.

string

management_network_type

Required

The type of the Network object used for the Management network.

For more information see: Vcenter Vcha NetworkType.

This property was added in vSphere API 6.7.1.

storage

Required

The storage information of the VCHA node.

This property was added in vSphere API 6.7.1.

string

bios_uuid

Optional

BIOS UUID for the node.

This property was added in vSphere API 6.7.1.

If missing or null, the information is currently unavailable.